package alertmanager

Import Path
	github.com/K-Phoen/grabana/alertmanager (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	    contactpoint.go
	    manager.go
	    routing.go
Package-Level Type Names (total 6)

	/* sort by: alphabet | popularity */
	 type Contact (struct)
		Contact describes a contact point.

		Fields (only one)
			Builder *sdk.ContactPoint
		As Outputs Of (at least one exported)
			func ContactPoint(name string, opts ...ContactPointOption) Contact
		As Inputs Of (at least one exported)
			func ContactPoints(contactPoints ...Contact) Option

	 type ContactPointOption (func)
		ContactPointOption represents an option that can be used to configure a
		contact point.

		As Inputs Of (at least one exported)
			func ContactPoint(name string, opts ...ContactPointOption) Contact

	 type Manager (struct)
		Manager represents an alert manager.

		Methods (total 2)
			(*Manager) MarshalIndentJSON() ([]byte, error)
				MarshalIndentJSON renders the manager as indented JSON.

			(*Manager) MarshalJSON() ([]byte, error)
				MarshalJSON implements the encoding/json.Marshaler interface.

		Implements (at least 2)
			*Manager : github.com/goccy/go-json.Marshaler
			*Manager : encoding/json.Marshaler
		As Outputs Of (at least one exported)
			func New(opts ...Option) *Manager
		As Inputs Of (at least one exported)
			func github.com/K-Phoen/grabana.(*Client).ConfigureAlertManager(ctx context.Context, manager *Manager) error

	 type Option (func)
		Option represents an option that can be used to configure an
		alert manager.

		As Outputs Of (at least 5)
			func ContactPoints(contactPoints ...Contact) Option
			func DefaultContactPoint(contactPoint string) Option
			func DefaultGroupBys(labels ...string) Option
			func Routing(policies ...RoutingPolicy) Option
			func Templates(templates map[string]string) Option
		As Inputs Of (at least one exported)
			func New(opts ...Option) *Manager

	 type RoutingPolicy (struct)
		RoutingPolicy represents a routing policy.

		As Outputs Of (at least one exported)
			func Policy(contactPoint string, opts ...RoutingPolicyOption) RoutingPolicy
		As Inputs Of (at least one exported)
			func Routing(policies ...RoutingPolicy) Option

	 type RoutingPolicyOption (func)
		RoutingPolicyOption represents an option that can be used to configure a
		routing policy.

		As Outputs Of (at least 4)
			func TagEq(tag string, value string) RoutingPolicyOption
			func TagMatches(tag string, regex string) RoutingPolicyOption
			func TagNeq(tag string, value string) RoutingPolicyOption
			func TagNotMatches(tag string, regex string) RoutingPolicyOption
		As Inputs Of (at least one exported)
			func Policy(contactPoint string, opts ...RoutingPolicyOption) RoutingPolicy


Package-Level Functions (total 12)

	 func ContactPoint(name string, opts ...ContactPointOption) Contact
		ContactPoint defines a new contact point.

	 func ContactPoints(contactPoints ...Contact) Option
		ContactPoints defines the contact points that can receive alerts.

	 func DefaultContactPoint(contactPoint string) Option
		DefaultContactPoint sets the default contact point to be used when no
		specific routing policy applies.

	 func DefaultGroupBys(labels ...string) Option
		DefaultGroupBys sets the default labels that alerts should be grouped by.

	 func New(opts ...Option) *Manager
		New creates a new alert manager.

	 func Policy(contactPoint string, opts ...RoutingPolicyOption) RoutingPolicy
		Policy defines a routing policy that applies to the given contact point.
		All the options given on this policy will be combined using a logical "AND".

	 func Routing(policies ...RoutingPolicy) Option
		Routing configures the routing policies to apply on alerts.

	 func TagEq(tag string, value string) RoutingPolicyOption
		TagEq defines an equality ("=") constraint between the given tag and value.

	 func TagMatches(tag string, regex string) RoutingPolicyOption
		TagMatches defines a similarity ("=~") constraint between the given tag and regex.

	 func TagNeq(tag string, value string) RoutingPolicyOption
		TagNeq defines a non-equality ("!=") constraint between the given tag and value.

	 func TagNotMatches(tag string, regex string) RoutingPolicyOption
		TagNotMatches defines a non-similarity ("!~") constraint between the given tag and regex.

	 func Templates(templates map[string]string) Option
		Templates defines templates that can be used when sending messages to
		contact points.
		See https://prometheus.io/blog/2016/03/03/custom-alertmanager-templates/

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.